| "callback name" | callback description | callback function signature |
| "init" | Called during initialization
return value: none | void (* myfunction)(void); |
| "free" | Called during un-initialization
return value: none | void (* myfunction)(void); |
| "start" | Called when the mirror starts. The opt structure passed lists all options defined for this mirror. You may modify the opt structure to fit your needs
return value: 1 upon success, 0 upon error (the mirror will then be aborted) | int (* myfunction)(httrackp* opt); |
| "end" | Called when the mirror ends
return value: 1 upon success, 0 upon error (the mirror will then be considered aborted) | int (* myfunction)(void); |
| "change-options" | Called when options are to be changed. The opt structure passed lists all options, updated to take account of recent changes
return value: 1 upon success, 0 upon error (the mirror will then be aborted) | int (* myfunction)(httrackp* opt); |
| "check-html" | Called when a document (which may not be an html document) is to be parsed. The html address points to the document data, of lenth len. The url_adresse and url_fichier are the address and URI of the file being processed
return value: 1 if the parsing can be processed, 0 if the file must be skipped without being parsed | int (* myfunction)(char* html,int len,char* url_adresse,char* url_fichier); |
| "query" | Called when the wizard needs to ask a question. The question string contains the question for the (human) user
return value: the string answer ("" for default reply) | char* (* myfunction)(char* question); |
| "query2" | Called when the wizard needs to ask a question | char* (* myfunction)(char* question); |
| "query3" | Called when the wizard needs to ask a question | char* (* myfunction)(char* question); |
| "loop" | Called periodically (informational, to display statistics)
return value: 1 if the mirror can continue, 0 if the mirror must be aborted | int (* myfunction)(lien_back* back,int back_max,int back_index,int lien_tot,int lien_ntot,int stat_time,hts_stat_struct* stats); |
| "check-link" | Called when a link has to be tested. The adr and fil are the address and URI of the link being tested. The passed status value has the following meaning: 0 if the link is to be accepted by default, 1 if the link is to be refused by default, and -1 if no decision has yet been taken by the engine
return value: same meaning as the passed status value ; you may generally return -1 to let the engine take the decision by itself | int (* myfunction)(char* adr,char* fil,int status); |
| "pause" | Called when the engine must pause. When the lockfile passed is deleted, the function can return
return value: none | void (* myfunction)(char* lockfile); |
| "save-file" | Called when a file is to be saved on disk
return value: none | void (* myfunction)(char* file); |
| "link-detected" | Called when a link has been detected
return value: 1 if the link can be analyzed, 0 if the link must not even be considered | int (* myfunction)(char* link); |
| "transfer-status" | Called when a file has been processed (downloaded, updated, or error)
return value: must return 1 | int (* myfunction)(lien_back* back); |
| "save-name" | Called when a local filename has to be processed. The adr_complete and fil_complete are the address and URI of the file being saved ; the referer_adr and referer_fil are the address and URI of the referer link. The save string contains the local filename being used. You may modifiy the save string to fit your needs, up to 1024 bytes (note: filename collisions, if any, will be handled by the engine by renaming the file into file-2.ext, file-3.ext ..).
return value: must return 1 | int (* myfunction)(char* adr_complete,char* fil_complete,char* referer_adr,char* referer_fil,char* save); |
| "send-header" | Called when HTTP headers are to be sent to the remote server. The buff buffer contains text headers, adr and fil the URL, and referer_adr and referer_fil the referer URL. The outgoing structure contains all information related to the current slot.
return value: 1 if the mirror can continue, 0 if the mirror must be aborted | int (* myfunction)(char* buff, char* adr, char* fil, char* referer_adr, char* referer_fil, htsblk* outgoing); |
| "receive-header" | Called when HTTP headers are recevived from the remote server. The buff buffer contains text headers, adr and fil the URL, and referer_adr and referer_fil the referer URL. The incoming structure contains all information related to the current slot.
return value: 1 if the mirror can continue, 0 if the mirror must be aborted | int (* myfunction)(char* buff, char* adr, char* fil, char* referer_adr, char* referer_fil, htsblk* incoming); |
